Wiki

Clone wiki

EspecWeb / Terumo-ES Web Controller Manual

Table of Contents

1 Introduction

This is the operation manual for the custom version of ESPEC Web Controller, Version 2.5, specifically customized for TERUMO BCT. Many of the customizations requested by TERUMO BCT were added to the standard release of ESPEC Web Controller v2.5. Few key features that stand out are the user interface in Spanish, an option to toggle between English and Spanish. Additional features not in the standard release are: alarms/faults functionality, electrical power loss alarm, light stack message, read-only access to the Program menu for the Technician account, program structure and a message for program completion. These features are presented with detailed explanation in a separate chapter at the end of this manual, Chapter 16. The last chapter provides detailed procedure on the custom configuration of ESPEC Web Controller if it underwent a system or firmware restoration.

ESPEC Web Controller is an embedded computer powered by GNU/Linux operating system based on Debian distribution. The hardware platform is an embedded UP2Board x86 architecture by AAEON. Through stack programming, this embedded computer is customized and configured to utilize a standard Web browser to provide or host its user interface (UI) to operate and control the chamber; hence, the name Web Controller. The system can be part of a network using its unique hostname and IP address to allow access to its UI via a Web browser. Thanks to the ability of a Web browser to operate from any computer on the network, operations of the chamber can be performed via the Web Controller UI remotely by authorized users. Access to the Web Controller is possible only for any device on the same network. No device outside the network can access the Web Controller.

With ESPEC Web Controller, the tedious process of controlling or programming the chamber via the controller HMI is now replaced with the UI of the Web Controller which offers multi-tasking capabilities. Many practical features offered by ESPEC Web Controller include chamber alerts via an e-mail communication, remote operation through RESTful API, data-logging, access to other Web Controllers (and chambers) on the same network, and much more. These and other features will be described in detail in this manual.

To guard against security breach on ESPEC Web Controller, its root filesystem is configured to permit read-only access. By nature, the GNU/Linux operating system alone is already a secure system. However, the read-only access to the system's root filesystem puts in place another layer of defense mechanisms to deny an intruder the ability to install any software or modify the system's configurations. To provide robustness in terms of stability and self-correct operation, ESPEC Web Controller has a dual root partition structure. This configuration ensures that during a system update (or upgrade) at least one root partition is always in the stable operating state. This feature thereby provides seamless updates and overall system management. In short, ESPEC Web Controller is robust, secure, easy to manage and operate.

This manual has been prepared to address all the relevant features exist in the custom Web Controller, V2.5, for TERUMO BCT.

1.1 How to Use the Online Manual

This manual is currently available in two formats: (1) Online and (2) PDF. The online manual is structured for easy navigation via the Table of Contents. Instead of scrolling down the Web page, users can jump to a specific chapter or section by just clicking on the specific topic listed under the Table of Contents (at the top of the Web page). Click the back button on the Web page to return to the Table of Contents to select a new topic.

1.2 Operating System, Software or Hardware Requirement

No software installation is required to use the Web Controller. Only a Web browser running on the local computer is needed to access the Web Controller via its IP address or hostname to control the chamber (see Chapter 2). A computer running MS Windows, Mac OS X or Linux can operate the Web Controller. A handheld device, such as a smartphone, on the same network can also access and operate the Web Controller.

1.3 Web browser Compatibility

ESPEC Web Controller supports the following Web browsers: Chromium, Google-Chrome, Mozilla Firefox, Microsoft Edge, Apple Safari and Opera. Microsoft Internet Explorer Version 9 or higher can also be used to access and operate the Web Controller. However, due to its slow performance, the use of Microsoft Internet is strongly discouraged.

1.4 ESPEC Web Controller Home Page

Every time ESPEC Web Controller starts, it displays its home page. The following figure depicts ESPEC Web Controller home page on the Google Chrome Web browser which was accessed via its IP address (http://10.30.200.246/). Chapter 2 explains in detail how to access ESPEC Web Controller via its IP address or its hostname.

Web Controller home page on local computer

The following figure outlines the important components of ESPEC Web Controller.

ESPEC Web Controller display coomponents The home page has the following components labeled and described as follows:

  1. Menu Bar: ESPEC Web Controller has six main operation menus grouped together in the menu bar which remains fixed on the top throughout the operation. Language selection and user account login selection are located in the right of the menu bar. These menus are clickable links which lead to their own page; some of which have submenus to provide further control of the system. These menus require access privilege as described in Section 1.5. The six available main menus at the top may be accessed at this point. To return to the home page from any menu, click the ESPEC logo in the menu bar.

  2. Main Display: Contents associated with each specific menu in the menu bar are displayed in this main display area. In the home page (above figure), the main display basically displays each menu as a clickable link.

  3. Status Bar: The status bar displays the status of the chamber operation mode and its condition. The bar remains fixed on the right under Monitor, Constant, Program and Run/Stop menu operation. The status bar provides a quick at-a-glance view of the currently running program. Section 5.1 presents a detailed description of the status bar.

  4. Language and Login Options: The globe icon allows option to select English or Spanish for the user interface. In order to gain full control (or specific control) of the Web Controller, each user must log in using their credentials. Section 3.1 explains this procedure in detail.

1.4.1 ESPEC Web Controller Display on Desktop

The home page automatically handles and renders the display based on the Web browser window or the monitor resolution, as depicted in the previous figure. If the display screen is too narrow, the menu bar collapses and becomes a drop-down menu indicated by the arrow in the following figure. It mimics a handheld display (discussed below).

Overview page in a smaller display screen

1.4.2 ESPEC Web Controller Display on Handheld Device

ESPEC Web Controller can be accessed wirelessly through a handheld device, such as a tablet PC or a smartphone, provided the device is part of the main network that the Web Controller is connected to. Typical display of the Web Controller Overview page on a handheld device is depicted in the following figure.

The Web Controller home page is depicted in the following figure. Elements of the page content that are common to all the pages are illustrated for desktop/tablet and mobile devices.

The Desktop page view

Description of elements on the home page:

  1. Navigation bar: The navigation bar contains links to each page on the Web Controller. On a mobile device, this navigation bar collapses into an expandable menu.
  2. Location bar: The location bar shows the current Web Controller name (i.e., hostname), which also acts as a drop-down menu to access other controllers. If the Web Controller is part of a network, this menu displays links to all other Web Controllers.
  3. Page contents: Every time the Web Controller is open on a web browser, it first displays a home page. Its page contents look different on different devices. The figure illustrates the difference of the page contents displayed on a standard computer/tablet screen and a mobile device.
  4. Status bar: The status bar allows a quick at-a-glance view of the current state of the chamber. On a mobile device, this bar is located at the bottom of the display.
  5. Quick status: Since the mobile view pushes the status bar to the bottom of the screen, the most relevant information is shown in the navigation bar for mobile devices. The first line displays the chamber's current run status such as Standby, Constant, Program or Alarm. The second line displays the conditions inside the chamber such as temperature and humidity.

The discussion in this manual will focus on the Web Controller operation using the Web browser on a desktop or laptop computer.

1.5 User Account Types

To help protect the chamber from getting damaged by unauthorized users or users with limited knowledge of the chamber operation, user accounts with different level of privileges can be created. ESPEC Web Controller for TERUMO BCT is shipped with only one account (called admin) who will manage and administer different account types to those users who will operate the chamber. Different level of privileges are outlined in the following table:

Account Home Monitor Constant Program Run/Stop Network Setup
Guest RO RO NA NA RO RO NA
User RO RO NA RO RW RO NA
Technician RO RO RW RO RW RO NA
Administrator RO RO RW RW RW RW RW

where NA, RO or RW under each menu has the following meaning:

  • NA stands for No Access. Users with NA privilege cannot access the Web Controller page (or menu) in any form.
  • RO stands for Read-Only access. Users with RO privilege may view the contents of any page (or menu).
  • RW stands for Read-Write access. Users with RW privilege can access, view and modify the contents of any page (or menu).

These NA, RO and RW access types can be used by the administrator (admin) to assign access privilege to different user accounts on the Web Controller.

The Guest account outlined in the above table can only access the Web Controller home page and monitor page in view mode. This account represents a user who is not actually logged into the Web Controller. The home page of ESPEC Web Controller is displayed using this account as a starting point for authorized users to log in.

The administrator account has the following credentials:

  • username: admin
  • password: admin

The Web Controller requires the user to log in with this account type. Additional accounts can be created to apply different privileges for designated users.

2 Initial Setup and First-Time Use

ESPEC Web Controller can be connected to a Dynamic Host Control Protocol (DHCP) network or a static network. The following sections describe how to set up the chamber and computer on these two types of network.

2.1 DHCP Network Setup

By default, ESPEC Web Controller applies DHCP to obtain an IP address assigned by the DHCP server to join the network. The configuration is done automatically on the Web Controller as soon as it detects a DHCP server on the network.

To connect the chamber (and Web Controller) to a DHCP main network, complete the following steps:

  1. Plug an RJ-45 Ethernet cable into the Ethernet port on the chamber, as depicted in the following figure.

    EP/EGN/EWP/EWS/EN Chambers
    ESPEC chambers
  2. Plug the other end of the cable into an Ethernet port (or a router) that connects to the main network.

  3. Your computer (PC or laptop) must also join the main network as shown in the following diagram.

    Network connection on a DHCP setup

To access and use the Web Controller wirelessly from a laptop (or a handheld device), that laptop (or handheld device) must also join the main network through a wireless connection.

2.2 Static Network Setup

2.2.1 Small Number of Network Hosts

By default, ESPEC Web Controller applies DHCP to obtain an IP address from the DHCP server to join the network. If DHCP service is not available, the Web Controller uses its preconfigured Class C static network settings called fallback static IP:

  • IP Address: 192.168.0.83
  • Subnet Mask: 255.255.255.0
  • Gateway: 192.168.0.1

This static network protocol occurs when ESPEC Web Controller is connected directly to a computer via a crossover cable or a network hub without DHCP service. This preconfigured network protocol is suitable for a small number of hosts on the network where the first three groups of IP address (i.e., 192.168.0) identify the network and the last group defines the host.

To set up a Class C static network, complete the following steps:

  1. Plug an RJ-45 Ethernet cable into the Ethernet port on the chamber.
  2. Plug the other end of the cable into the Ethernet port of the computer or into an Ethernet port of a network hub. If a network hub is used, your computer must also connect to it via an Ethernet cable.
  3. Your computer should be connected to the chamber directly or via a network hub as pictured below.

    Network connection on a static setup

Your computer must also use a Class C network protocol. Complete the following steps to configure a static IP address with the following recommendation:

  • IP Address: 192.168.0.84
  • Subnet Mask: 255.255.255.0
  • Gateway: 192.168.0.1
  • Preferred DNS server: 8.8.8.8
  • Alternate DNS server: 8.8.4.4

Administrative privilege may be required to perform the configuration on your computer. Your IT department may need to get involved in the preparation for the static network setup as this could become a complicated process. The following steps apply on MS Windows 7/8/10:

  1. Hold down the Windows key and press R to launch the Run Command dialog box.
  2. In the Run dialog box, enter ncpa.cpl into the Open box field and press Enter.
  3. Point and Right-Click the "Local Area Connection" icon, then click Properties from the drop-down menu (as illustrated in the following figure). NOTE: The Local Area Connection icon is the one connected to a hub (or the Web Controller via a straight-through or crossover Ethernet cable). It is important to access the correct icon in case your computer has multiple Ethernet ports or devices.

    Selecting the right Local Area Connection

  4. In the "Local Area Connection Properties" window, confirm that there is a check mark placed in front of "Internet Protocol Version 4 (TCP/IPv4)", as illustrated in the following figure. If not, check it. Click to highlight "Internet Protocol Version 4 (TCP/IPv4)" and then click Properties in the lower-right corner.

    Setting TCP/IPv4 properties

  5. In the "Internet Protocol Version (TCP/IPv4) Properties" window, turn on the radio button for "Use the following IP address:" and enter these settings (see the figure below):

    • IP Address: 192.168.0.84
    • Subnet Mask: 255.255.255.0
    • Gateway: 192.168.0.1
  6. In the ``Use the following DNS server addresses:'' section, enter the following address (as shown in the following figure):

    • Preferred DNS server: 8.8.8.8
    • Alternate DNS server: 8.8.4.4
  7. Turn on "Validate settings upon exit" with a check mark and click OK, as illustrated in the following figure.

    The complete static IP config on the TCP/IPv4 connection

  8. Click OK to close "Local Area Connection Properties" window.

  9. Close out the Network window.
  10. To access the Web Controller, proceed to Section 2.3.2.

2.2.2 Large Number of Network Hosts

The Web Controller can use a static IP address on a network with large number of hosts, such as Class A or B. Your IT department will need to get involved in the configuration and provide a static IP address for the Web Controller to join your company network.

2.3 Accessing ESPEC Web Controller

ESPEC Web Controller can be accessed via its hostname or its IP address. If the Web Controller is shipped with the chamber as a single unit, its hostname is ESPECserial# where serial# is the serial number of the chamber which can be found on the label affixed on the chamber panel, as depicted in the following figure. If the Web Controller is purchased separately as a U-Web kit, its hostname is ESPEC-default. Follow the instructions that come with the U-Web kit to set up the Web Controller to join your DHCP or static network.

Serial number of the chamber

A new hostname can be assigned to the Web Controller via the Settings menu (described in Section 9.2). It is recommended that the default hostname be used during the initial setup. A new hostname may be assigned to the Web Controller after it has successfully joined the main network.

2.3.1 How to Locate ESPEC Web Controller Hostname or IP address

ESPEC Web Controller for the TERUMO BCT chamber has the dedicated touchscreen monitor to provide the user interface and control the chamber. Therefore, the hostname or IP address of ESPEC Web Controller can be located in the Setup menu, under the Hostname and Network Configuration tab, accessible by the administrator, as shown in the following figure.

Web Controller hostname and IP address

  1. Host: Depicted in this field is the hostname of the Web Controller as configured at the manufacturer's facility. To assign a different hostname for the Web Controller, enter the new hostname and click Apply.
  2. DHCP: This box, if checked, sets ESPEC Web Controller to join a DHCP network by using a leased IP address provided by the DHCP server of the network. It is best to initially set DHCP to establish network connection and later set a static IP address assigned and allowed by the IT group that oversees the network.
  3. IP address: This is the IP address of the Web Controller. If DHCP is used, the IP address is assigned by the DHCP server. Depicted in the above figure is a static IP address. However, if the Web Controller is not connected to any network, its IP address will register as 0's, as shown in the following figure.

    No network connection; Web Controller standalone

  4. MAC Address: This is the MAC address of the Web Controller hardware; the designated Ethernet port being used for the network connection.

Without relying on the touchscreen monitor, there are two ways to locate ESPEC Web Controller hostname or IP address.

  1. F4T HMI: When ESPEC Web Controller starts and is in communication with the chamber, it posts its hostname and IP address on the chamber's controller. With Watlow F4T, this information is displayed on the Message tab via the Controller Status button, as depicted in the right image of the following figure.

    The Watlow F4T message screen

  2. ESPEC Web Controller Locator Utility: Looking up the Web Controller's hostname or IP address via ESPEC Web Controller Locator utility is more convenient when access to the F4T HMI is not possible. The software is MS Windows-based and executable on Windows 7/8/10, which does not require installation on the local computer. It is a free download available at: https://espec.com/images/uploads/files/espec_web_controller_locator.exe. Once executed, the utility scans for ESPEC Web Controllers (ver. 2.0 and higher) on the network. It displays hostname, IP address and firmware version, as depicted in the following figure. Hostname and IP address are listed as clickable links. The IP addresses are listed in the second column. To access the controller, click on its IP address. The hostname is accessible only if the computer can resolve it, in which case the hostname becomes a clickable link, as depicted in the following figure. The last entry in the figure also illustrates an example of a hostname which has not be resolved; and therefore, this Web Controller can only be accessed via its IP address.

    ESPEC Web Controller Locator Utility

2.3.2 Accessing ESPEC Web Controller on a DHCP Network

The advantage of the touchscreen monitor, directly connected to the Web Controller, mounted on the front panel permits a quick way to look up the hostname or IP address in the Setup menu. This information can then be used to access the Web Controller from any computer on the network via the standard Web browser.

  1. With both the chamber and computer joined the network as described in Section 2.1, apply power to both devices.
  2. On your computer, open a Web browser of your choice based on the list provided in Section 1.3.
  3. Enter the hostname or IP address (found under the Setup menu on the touchscreen monitor) in the URL address field of the Web browser. The format of the Web Controller address is: http://hostname.local/ or http://IP-address/
  4. Since this Web Controller was customized and preconfigured for the TERUMO BCT chamber, users may begin using the Web Controller by logging into their assigned account. Note: When ESPEC Web Controller is accessed for the first time, its Setup Wizard page may appear. Proceed to Section 2.4 to complete this Setup Wizard page.

2.3.3 Accessing ESPEC Web Controller on a Static Network

If a static network configuration based on Section 2.2.1 is used, the IP address of the Web Controller can still be obtained in the Setup menu found on the touchscreen monitor, which should be: 192.168.0.83. Complete the following steps to access the Web Controller on a static network for the first time.

  1. With both the chamber and computer joined a static network as described in Section 2.2, apply power to both devices.
  2. On your computer, open a Web browser of your choice based on the list provided in Section 1.3.
  3. Enter http://192.168.0.83/ in the URL address field of the Web browser. This IP address should be confirmed on the touchscreen monitor.
  4. Since this Web Controller was customized and preconfigured for the TERUMO BCT chamber, users may begin using the Web Controller by logging into their assigned account. Note: When ESPEC Web Controller is accessed for the first time, its Setup Wizard page may appear. Proceed to Section 2.4 to complete this Setup Wizard page.

2.4 ESPEC Web Controller and Setup Wizard

ESPEC Web Controller for TERUMO BCT chamber has been customized and configured ready for operation. For this reason, the following procedure via the Setup Wizard may not be necessary. However, it is discussed here to provide a complete detailed operation of the Web Controller in general when it is first turned on at the customer's facility.

Before ESPEC Web Controller can be used for the first time, its basic settings must be confirmed and completed via the Setup Wizard. This process ensures that ESPEC Web Controller is configured correctly for the intended chamber, which includes the login configuration, chamber interface communication, e-mail alerts, network and administrator's password. The Setup Wizard page appears as follows:

  1. Setup Wizard 1 of 4: Chamber Interface Setup / Software License Agreement

    • Enter the Administrator's password (admin) to log in.
    • Scroll down the Software License Agreement page to read the rest of the agreement.
    • Click ACCEPT to proceed, as depicted in the following figure.

      Accept terms of license agreement

  2. Setup Wizard 2 of 4: Network Setup

    • Record hostname and IP address for reference.
    • Confirm and note that the system uses DHCP for its network protocol, as depicted in the following figure.

      Network configuration

    • Click Apply to proceed.

  3. Setup Wizard 3 of 4: Email Setup

    • This page has pre-configured parameters to satisfy the default and general setup, and thus can be skipped.
    • If email alert is desired, scroll down and enter the recipient's address, one line per address, in the Alert Addresses box at the bottom. It requires that ESPEC Web Controller has access to the Internet in order to complete the email setup process. However, Internet access is not required for the rest of ESPEC Web Controller operation.

      Set up email alert

    • NOTE: If email alert setup is skipped at this point, it can be completed later via the Setup page (in the menu bar).

    • Click Apply to proceed. If setup failed (as shown in the following figure), click Save in the pop-up window to save the settings. The system will complete this setup when it detects Internet connection.

      Save email settings

    When ESPEC Web Controller is connected to the Internet, this configuration will operate normally.

  4. Setup Wizard 4 of 4: Admin account password.

    • The system requires that the administrator's password be changed to something more secure.

      Setup administrator's password

    • Enter the current password: ``admin''

    • Enter a new and secure password (twice).
    • Click Submit to save the setting.

ESPEC Web Controller will reboot to apply the settings.

Rebooting Web Controller

It will require 2-3 minutes to restart the system and refresh the Web page. Once reboot is complete, ESPEC Web Controller is now ready for use!

If the Web page fails to restart after 3 minutes, close it and open new Web page to reaccess ESPEC Web Controller.

3 User

This chapter describes the procedure how users log into ESPEC Web Controller to control and operate the chamber. The Web Controller protects the chamber by permitting only authorized users to login and operate the chamber. The following sections discuss how to login, logout and set a new password.

3.1 Login

To log into a specific account, proceed as follows:

  1. Click the Guest radio button then click Sing in, as depicted in the following figure.

    Log into the Web Controller

  2. Enter User Name and Password in the login window; press ENTER or click Submit to login.

    Enter correct Username and PAssword

If the login fails, an Invalid username or password message pops up, and the Web Controller resets itself to display its home page. If login is successful, the Web Controller sets the home page with its menus according to the user's privilege.

3.2 Logout or Login with Different Username

To log into a different account, click the login radio button (which now displays the current login name), click the Sign Out button in the drop-down menu (see figure below), and reapply the steps as outlined in the previous section.

Sign in with a different suername

3.3 Set New Password

There are two ways to set a new password:

  1. User-Own Setting: A user can reset their password via the login drop-down menu as depicted in the following figure.

    Resetting user password

    In the Change User Password pop-up window, enter the current password; enter the new password (twice); click Submit to apply the setting. To cancel the password setting, click the X to close out this pop-up window. If authentication is checked and confirmed, a new password becomes effective immediately.

  2. Administrator Setting: A user account and password can be reset by the administrator via the Setup menu.

    Resetting password via Setup menu

    This method will be discussed in detail in Section 10.7.

3.4 Login Error

The following error message occurs when a user attempted to log into and access a menu that the user has read-only privilege. This incident might occur in a situation where an administrative user (still in, say, the Program Editor menu) and attempted to sign in using a User and Technician account. The user is actually logged in but the error message indicated that this user does not have access to the current menu. When this error occurs, simply click the Monitor menu to remove the error message.

Login error

To prevent a login error shown in the above figure each user must logout properly, so that the next user can log in from the main menu. A logout setting can be put in place to automatically logout the current user when the UI has been idling for a certain amount of time.

4.0 User Interface and HMI Touchscreen in Spanish

This Web Controller supports user interface (UI) in Spanish, both for the Web browser and the touchscreen panel (HMI).

4.1 Language Preference on the Web browser

The globe icon next to the User login menu allows the operator to change language preference between English and Spanish, as depicted in the following figure. Click the globe icon and select the preferred language.

Set language preference

Language selection is affected immediately, as depicted in the following figure. To toggle between the two languages, click the globe icon again and select the preferred language.

Web Controller UI in Spanish

4.2 HMI Touchscreen Panel: Language Selection

When ESPEC Web Controller starts up, if it detects a monitor connected directly into its display port (via HDMI or video display), it will automatically start the the graphical user interface on the detected monitor. This trigger applies to both the standard monitor or the touchscreen monitor.

Standard operations on the Web Controller may be performed on the detected monitor. The UI supports both the capacitive and resistive touch screens, as well as keyboard and mouse. The general setting menu on the display can be accessed via the top center button indicated by the arrow in the following figure. Language selection can be configured via the general setting menu--the gear symbol (described below).

Touchscreen display (Kis)

The following sections discuss in the detail how to configure and use the HMI to control the Web Controller. In the following section, the touchscreen operation is referred to as HMI operation.

4.3.1 Touch Screen Menu Bar

The following figure depicts the Web Controller with the touchscreen menu bar displayed. Most of the controls are similar to those found in a standard Web browser. These controls are described as follows:

HMI Application Menu Bar

  1. Back Button: Navigate to the previous page.
  2. Forward Button: Navigate to the next page.
  3. Reload Button: Reload the current page.
  4. Home Button: Navigate to the home page. The home page is the index page shown in the screen shot.
  5. URL Bar: Navigate to a different url within the application. Access to any web page other than the built in web controllers is has been disabled. Certain commands may also be entered here to modify the applications behavior.
  6. Menu Button: This button is used to show or hide the the menu bar.
  7. Screen Shot: This button will take a screen shot, A USB drive must be connected to the system to save any screen shots.
  8. HMI Settings Button: This button will open a screen for setting up some common system parameters.
  9. USB Eject Button: This button will allow the user to safely eject USB devices. This button along with the Menu Button (Item 6) will flash orange when USB devices are connected. It is important to eject all USB devices before removing them to ensure no data is lost.

4.3.2 USB Storage via Touchscreen Panel (HMI)

Data file can be downloaded from the Web Controller to the local computer that is being used to access the Web Controller. This option is possible only if the Web Controller is part of the main network where the local computer can access the Web Controller. If the chamber (and the Web Controller) is isolated (not part of a network), data file can still be handled as described below.

Files can be transferred into or out of the Web Controller via a USB thumb drive, with it directly plugged into the USB port of the Web Controller hardware. This USB thumb drive must be formatted using the MS Windows FAT filesystem in order for the Web Controller to read and write files on it.

How to use the USB thumb drive: The Web Controller hardware is located behind and inside the touchscreen panel box. Only an authorized and trained personnel should open this touchscreen panel box to access the Web Controller hardware.

  1. Press on the lower-right edge of the touchscreen panel slightly upward and pull out to open the panel, as indicated by the arrows.

    Pull out the touchscreen panel door

  2. Locate the open USB port on the right of the Web Controller hardware as shown in the figure below.

    terumo-es-touchscreen-panel-002b.png

  3. Use a USB extension cable with your USB Thumb drive connected (see callout label 2), simply plug the USB cable into the USB port of the Web Controller hardware (see callout label 1), as shown in the figure.

    terumo-es-touchscreen-panel-004b.png

    Rearrange the USB cable to fit inside the panel box; close the panel to access the touchscreen.

  4. The Web Controller will automatically recognize and mount the USB thumb drive on the system. The following figure depicts a typical notification of a successful recognition of a USB thumb drive plugged into the Web Controller. The Eject Button (Item 9 in the previous figure) flashes to remind the operator that an external storage device is still plugged into the Web Controller hardware. Files can be transferred between the Web Controller and the USB thumb drive.

    Using USB for storage

How to Remove the USB thumb drive: Do not unplug (that is, simply pull out) the USB thumb drive from the USB port. Doing so would corrupt the filesystem on the USB thumb drive. To disconnect the USB thumb drive, perform the following procedure:

  1. Touch the Eject button (see Item 9 on the list in the previous section), then touch the name of the thumb drive in the drop-down menu, as depicted in the following figure. The system will update the filesystem on the USB thumb drive and dismount it from the Web Controller. A pop-up window may also appear to indicate ``USB device may now be safely removed.'' Tab Ok and unplug the USB device.

Safe to disconnect USB

  1. Open the touchscreen panel box to access the Web Controller hardware.

  2. Pull out the USB cable that connects your USB Thumb drive.

Where to Find Your Files on the USB: To keep relevant files in one place, ESPEC Web Controller creates a folder called Espec. Inside it, subfolders are created, with folder name based on the hostname of the Web Controller; files are stored in that specific folder.

4.3.3 Login via Touchscreen HMI

In order to operate and control the chamber via the touchscreen, the user must log into their account. The following figure depicts a typical login screen via the touchscreen, using the on-screen keyboard. To login, complete the following steps:

  1. Touch the login menu (Guest).
  2. Enter the username and touch the checkmark next to the entry field. Backspace key can be used to delete a character or clear the entry.
  3. Enter the password and touch the checkmark next to the entry field. Backspace key can be used to delete a character or clear the entry.

Touchscreen login

4.3.3 General HMI Settings

There are several system settings available that are specific to the application when running on a connected monitor. Details for the general settings menu are shown here. This menu is accessed via HMI Settings Button Item 1.

HMI Application Settings

  1. HMI Settings Button: This button will open a screen for setting up some common system parameters.
  2. Close/Cancel: Close the HMI Settings menu without saving any of the options.
  3. Time Zone: Configure the time zone the HMI application will use when displaying date/times that are not shown in the chamber time zone.
  4. Language: Configure the language of the HMI application. This will also set the language of the web interface unless the use overrides the language via the web interfaces controls (custom firmware for alternative languages is currently required).
  5. Display Timeout: Set the amount of time with no activity before the display will shut off the save power.
  6. Calibrate Touchscreen: If there is a resistive touch screen connected to the web controller this will open a menu for calibrating the touch screen. It is recommended to only use this if it is needed, if the calibration of the touch screen is very far off a mouse can be connected to get into the calibration system.
  7. Restart Application: This will restart the HMI application. The web application will not be restarted and no chamber state will be lost.
  8. Apply Button: This will apply any changed settings (excluding the Calibrate Touchscreen settings they have there own options.)

4.3.4 HMI Calibration

The general HMI calibration is discussed in Section 15.1.

5.0 Monitor Page

The Monitor page consists of four separate panels with information about the state of the chamber. These are Graph, Status Bar, Program Status and Operation Statistics.

Elements of the monitor page

  1. Graph: This panel displays a trend graph of the conditions inside the chamber, along with other settable information.
  2. Status Bar: The Status Bar also appears on the Constant and Program page. It displays the current status of the chamber.
  3. Program Status: This panel is visible only when a program is being executed; it displays the complete state of the running program.
  4. Operation Statistics: This panel displays basic operation statistics, as well as a list of past operating modes which the user can view.

These panels are described in detail in the following sections.

5.1 Status Bar

During operation, the chamber can be in one of four operation modes: Standby, Constant, Program Running, and Alarm. The following table describes these operation modes.

Status Description
Standby The chamber is currently not running.
Constant The chamber is currently running a constant set point.
Program Running The chamber is currently running a program; the current program and step are also listed.
Alarm The chamber is currently alarmed, this state must be cleared before operation may resume.

The Status bar

Elements of the Status bar:

  1. Operation Mode: The operation mode displays the current run mode of the chamber.
  2. Control Loops: The current condition inside the chamber is displayed as Set Point, Process Value and Power. If a condition is disabled, the Set Point will be displayed as off. The previous figure was shown with a temperature information only. If the conditions inside the chamber include temperature and humidity, or temperature and vibration, then both information will be displayed in this area.
  3. Time Signals: The current time signal status will be displayed as on or off.
  4. Alarm Status: The alarm status displays active alarms that may prevent the chamber from operating. These alarms must be cleared before a chamber can resume its operation.
  5. Chamber Date/Time: This area displays the current date and time of the chamber.

5.2 Graph

A data log of the chamber's operation is displayed as a trend graph. The graph provides an overview of the chamber's operation in the last 6 hours. The following figure depicts a trend graph of the P300 with only a temperature operating mode.

Monitor Page: Graph

Descriptions of elements and their operation:

  1. Full Screen Toggle: To display the graph in full screen within the browser window, click on the Toggle Full screen. Click it again to turn off full screen.
  2. Graph: This is an X/Y scatter plot of all the numerical data currently being shown.
  3. Status Graph: The status graph shows the current operating mode of the chamber.
  4. Zoom In: Zoom in on the graph.
  5. Zoom Out: Zoom out of the graph.
  6. User Settings: To set preferences on the graph, click the three vertical dots. The following options available by checking or un-checking the boxes:
    • Enable Zoom X(Time) axis: This toggle zoom button controls the scale of the x-axis.
    • Enable Zoom Y axis: This toggle zoom button controls the scale of the y-axis.
    • Enable Scroll wheel Zoom: This is the toggle zoom mouse wheel that controls the graph.
    • Edit Graph Series: This allows the user to control what is shown on the graph. Available options include:
      • Operation Data: Information about the operating mode of the chamber.
      • Control Loop Data: Information about the state of the control loops.
      • Time Signal Data: Information about the state of the time signals on the chamber.
      • Alarm Data: Information about the state of the chamber alarms.
    • Screenshot: Download the current graph as an image file.
  7. Pan/Zoom Extents: The arrow keys may be used to pan the graph around the available data. The center button may be used to zoom into all data for various time periods.
  8. Auto Refresh: This button (Toggle auto refresh) has an on/off switch to update the graph with new data. When switched to on (for auto refresh), the current graph will reflect new data with the most recent data points.
  9. Graph Range: Click this button to select a range of data points to be plotted on the graph. A drop-down window provides options for selecting data with Start Time and End Time. Click the button again to close the drop-down window.

Plotting selected range of data

  1. Download: Click this button to download data. A drop-down menu provides two options on how to download the data from the Web Controller:
    • Download All Data: Downloads all available fields for all time stored on the system. Note alarms will be condensed into a single field listing only active alarms.
    • Download Current View: Downloads the fields and time span exactly as it is shown on the graph.
  2. Legend: This window displays a caption of data and the color each type of data is mapped to. The window provides a toggle button to control the visibility of the graph. Click on the caption (or data name) to turn off its visibility on the graph; that is, to exclude that data from the graph.

Four additional control operations within the graphing window that can be manipulated via the mouse buttons:

  1. Left-click (Click): Click on the window area in the graph to display a window that lists data values for each operating mode, selected from the nearest date/time to the selected (clicked) area. Click on the X button to close the window.

Displaying a snapshot of data within the graph

  1. Click and Drag: This operation will zoom to the selected area.
  2. Middle-click and Drag (scroll-wheel click): Click and hold on the scroll wheel and drag to pan the graph to show the available data.
  3. Scroll wheel: Scroll the wheel to zoom in or out of the graph centered on the cursor. This operation can be disabled in the user settings for the graph.

5.3 Program Status

The Program Status panel in the following figure will appear in the display when the chamber is running a program. This panel is hidden when the chamber is not running a program.

Monitor Page: Program status

Description of elements on the Program Status page:

  1. Program: Displays program name that is currently running. As shown in the above figure, program named 99STEPS is being executed. The program name itself has a link that, when clicked, will open the program in edit mode, if you are logged in as an "Administrator" or a "Technician". If a "Guest User" clicks on the program name, the Web Controller will prompt for a password or ask the user to log in as a privileged user in order to turn on the edit mode. This feature is similar to accessing the program in edit mode via the Program Page.
  2. Current Step: Displays the current step number of the program being executed. As shown in the figure, step 2 is being carried out.
  3. Current Step Remaining Time: Displays the remaining time in HH:MM:SS on the current step.
  4. Cycle Counter(s): For a P300/SCP-220 controller, if the program contains a loop with Counter A, Counter B, or both turned on, the status of the loop will be displayed here. As shown, Counter A containing steps 1 and 2 will be repeated 999 times, with the current loop at 21. As shown in the figure, Counter B loops between step 3 and 99, which has yet to begin. The counter or loop feature is controller dependent. With the Watlow F4/F4T, information is estimated by watching the running program. This section is hidden when no cycling is used in the program.
  5. Total Remaining Time: Displays the remaining time of the entire program in HHHH:MM:SS.
  6. Scheduled Test End: Displays the estimated date/time at which the program will complete.

5.4 Operation Statistics

The operation statistics provides an overview of the Web Controller operation history. Two types of statistics:

  1. The percentage of time the chamber is in each operating mode (utilization).
  2. A detailed list of when the chamber changed operating modes; this allows the data from each mode to be viewed or downloaded conveniently.

Monitor Page: Statistics

Description of elements and their operation on the Operation Statistics page:

  1. Percentage Interval: A desired number of time interval in hours, days, weeks or months can be entered to generate the percentage pie chart, as depicted in call-out number 2.
  2. Percentage Chart: The percentage chart depicts the relative time that the chamber had spent in each mode.
  3. History Depth: The number of operating modes can be selected to display in the table via the history depth. The number of modes can be selected from 10, 25, 50, 100 or all. The table displays the date and time when the operation has started; its mode and program name, as described in the following call-out numbers (4-9).
  4. History Date/Time: Displays date and time at which the chamber started to operate in the listed mode.
  5. History Mode: Displays the type of mode in which the chamber was operating for this line of the history. As shown in the figure, three operating modes were listed: Alarm, Constant and Program. In Program mode, program number and name are also listed.
  6. History Program Number: This is the number for the program that was operating (if a program was running) for this line of the history.
  7. History Program Name: This is the name for the program that was operating (if a program was running) for this line of the history.
  8. History Download Data: Data of a particular operating mode for the line of history can be downloaded via the download (down-arrow) button. The fields present in this download are controlled by the "Edit Graph Series" controls detailed in 7.1 Item 6.
  9. History View Data: Data of a particular line of history can be viewed by clicking on the pop-up modal. The fields present in this graph are controlled by the "Edit Graph Series" controls detailed in 7.1 Item 6.

6.0 Constant Setup Page

The Constant Page allows setting of the constant mode, set point, time signals and other features, such as refrigeration power or air speed. Constant set point can be adjusted by entering the temperature, humidity, product control (if equipped) and time signal settings.

Constant Page

The following is a description of the elements on the Constant Setup Page.

  1. Control Loop Parameters: This is where each control loop parameters may be entered.
    • Mode: The operating mode of the control loops (such as Temperature, Humidity, Vibration):
      • On: The control loop will attempt to reach the set point automatically.
      • Off: The control loop will not attempt to control the set point.
      • Manual: The control loop will output a specified control power (Watlow F4T only).
      • Automatic: The control loop will attempt to reach the set point automatically (Watlow F4T only).
    • Set point: The target value that the control loop will try to reach.
    • Product Control: (optional) This will intentionally over drive conditions of the air in order to reach the product set point quicker. The available parameters for this feature are:
      • Enable: Turn this feature on or off.
      • +/- Deviation: The maximum allowable difference between the air and product parameters.
  2. Time Signals: This is where special features/digital outputs can be enabled/disabled. The Watlow F4/F4T refers to these as event outputs.
  3. Other: This is where other features may be controlled. For the P300/SCP-220, manual refrigeration outputs or air speed controls may be configured here via the drop-down menus. If there are no "other" parameters to be configured, this panel remains hidden.
  4. Apply / Start Constant Mode: This button can be used to apply new settings for a Constant Mode. An asterisk next to the Apply button indicates that new settings were entered but have not been written to the chamber. To save these settings, click Apply or click Apply & Start Constant Mode to apply new settings to the chamber and start the Constant Mode operation.
  5. Humidity Range Graph: This section displays the allowable range for humidity operation. On chambers without the humidity option, this portion will be hidden.
  6. Humidity Point: A plot of Humidity versus Temperature is shown in the graph. This shows where the entered temperature/humidity are in relation to the allowable range of operation.

7.0 Program

The Program menu allows the operator to create a program to control the chamber. All the programming features available on the supported PLC's listed in Chapter 1 ("Introduction") can be composed into programs to control the chamber. The operator can: (1) open and view a program; (2) preview the output of the program; (3) edit and/or overwrite an existing program ; (4) delete program from the list; (5) rename program on the list; (6) download a program and store it on the local computer in JSON file; (7) upload a program from the local computer to the Web Controller, and much more.

Here are some of the benefits of the Program menu:

  • Easy to operate.
  • Quick management of programs, programming or editing.
  • Require less time to develop a new program or modify an existing program.
  • Program Editor offers flexibility with multitasking capabilities.
  • Control program operation and program end mode.
  • Preview program operation before execution; operator can see exactly what the program does prior to its execution.
  • Download program from the Web Controller to the local computer for backup.
  • Upload program from the local computer to the Web Controller.

Only authorized users with read-write privilege can access and utilize the Program menu. The menu is grayed out, as depicted in the following figure. Access to the menu requires read-write privilege and the user log into their account to use the menu.

7.1 Program List

The following figure depicts a typical layout of the Program page. This is the default display of program list when the Program menu is accessed by the authorized user. Its UI components are numbered and explained as follows:

program-list-001a.PNG

  1. Program Slot Number: ESPEC Web Controller identifies each program by its slot number stored in the register of the Watlow F4T. This list reflects the actual list of programs read from the F4T register. A total of 40 program slots are available, numbered from 1 to 40.
  2. Program Name: All available programs are listed under the Name column by program name. These programs are stored by their slot number. Any slot not yet occupied by the program is mark EMPTY. Users can access each program under this list by clicking on the program name, which is a clickable link. The program editor then opens up to display the program instructions. Detailed operation of the program editor is discussed in the next section. Displays the name of a program.
  3. Download Program: Program can be downloaded and saved on the local computer. Program file will be saved as: program_slot#.json, where slot# references the program number slot number.
  4. Upload Program: Program can be uploaded from the local computer to the Web Controller which will then be stored in the F4T register using the slot number where the action was applied.
  5. Delete Program: A program to the left of the trash bin (where this action is applied) will be deleted. The F4T register will no longer contain this program.
  6. Run Program: Program can be initiated (i.e., run) by clicking on the play button. This option offers a fast and convenient way to stop and start a program instantly.

7.2 Program Editor Page

Program viewing or editing is done on this page. Each supported chamber controller has its own version of this page, but some common elements shared between them are presented here. The following sections will provide details on how to create a program for a particular controller. To launch the program edit page, click on the program name on the list (see Section 9.0) or click on EMPTY. The following figure shows the program editing page after clicking on a program named PGM-01. Changes to a program may be made by "Technician" and "Administrator" user accounts, the "User" account type may view programs only.

Program edit page common elements

Common elements referenced by the call-out labels in the above figure:

  1. Program Selector: The Program Editor has a drop-down menu to display a list of available slots to store programs. To access any program on the list, click on its name. This action will leave the current program editing page. Any unsaved changes made on the current program will be lost.
  2. Program Details: In the Program Details section, a program name can be edited; program execution behavior can be configured, such as what action to take after the current program completes its execution.
  3. Program Steps: The core programming is taking place in this section; a new program can be created, program step can be added, removed or edited.
  4. Download: The current program can be downloaded and saved on the local (user's) computer. Filename used for the download program is: program_0.json.
  5. Save To: The current program can be saved onto a different slot than the one being edited (or used). Note: If the selected slot has a program in it, that program will be overwritten by the current program. This option can only be performed once.
  6. Save #: This button will save the current program to the current slot. Any changes made in the program will also be saved.
  7. Program Preview: Displays the operation output of the program being edited. It is a graph of what the program looks like when it executes.

7.3 Program Edit Page for Watlow F4T

The following procedure is used to edit a program for the Watlow F4T:

  1. Enter the program name, guaranteed soak deviation, and data logging settings in the Program Details panel.
  2. Complete each program step; that is, fill in each program step in the Program Steps panel.
    1. Select a step mode (if an instant set point change is not desired).
    2. Enter step duration (not applicable for Jump, Ramp Rate, or End mode steps).
    3. Enter the loop details, enable guaranteed soak, set point, etc.
    4. Enter the time signal settings.
  3. Repeat item 2 for each step.
  4. Three options are available for managing the completed program:
    1. Download: Download the current program to the local (user's) computer. Filename used for the download program is: program_0.json.
    2. Save To: Save the current program to a different slot than the one being edited (or used). Note: If a selected slot has a program in it, that program will be overwritten by the current program.
    3. Save #: Save the current program to the current slot. Any changes made in the program will also be saved.

7.3.1 Program Details

For a Watlow F4T model, the Program Details page displays a Program Name, Data Logging option, Temperature and Humidity Guaranteed Soak (GS) Deviation option. An existing program name can be edited in the Name field. The Web Controller will flag an error message if a character other than standard English alphabet is used.

F4T program edit details

Description of Elements on the Program Details page:

  1. Program Name: Program name; alpha-numeric characters are required. Program will not be saved without a program name.
  2. Log Data: Log data on the controller for Watlow F4Ts that have this feature installed (optional).
  3. Guaranteed Soak Deviation: How close the set point must be to the process value for the step duration timer to count down.

7.3.2. Program Steps

If an existing program is selected from the Program Page for editing, the Program Steps page will display the program steps as depicted in the following figure. As shown, the program contains five steps. To edit a step, fill in the values or parameters in the column fields. To remove a step, click on the (-) button next to the step number. To insert or add a new step, click on the (+) button next to the step number. A copy of the current step will be inserted below it.

Programming structure of F4T on Program Editor

To create a new program, click the next EMPTY name under the Name column. A new Program Steps page will display the program steps starting at step 1 with the rest of the fields empty. The Program Name field will be blank; a new name must be created for it. Seven step types or modes are available for implementing a program: Ramp Time, Ramp Rate, Soak, Wait, Instant Change, Jump and End.

Description of the program step for the Watlow F4T:

  1. Step: The first column indicates the step of the program. Program will be executed sequentially starting from step 1 to the last step. A step can be inserted or removed using the (+) or (-) buttons, respectively. The (+) button will insert a new step right below the current step where (+) is clicked. In addition, the "Append Step" button can be used to insert a new step; this new step will be placed as the last step. On the last step, only the option to set the end condition is available; when selected, the standard parameters will be replaced with the option to stop the chamber when the program ends, including any Temperature or Humidity loop modes.
  2. Step Mode: The building blocks of programs or profiles are based on the step types. They can be used to create simple or complex profiles involving inputs and outputs. The properties of these step types are outlined as follows:
    • Jump: With the Jump feature, the program can jump to a specified step a specified number of times.
    • Soak: Instead of changing the set point the program will maintain the previous set point for a specified “Step Duration”.
    • Ramp:
      • Off: The set point will be changed instantly.
      • Time: The set point will be ramped to the new set point over the given duration.
      • Rate: The set point will be ramped at a given rate.
  3. Step Duration: The duration of the step are in HH:MM:SS. If a value is greater than 60 minutes or seconds, the Web Controller will convert the value using the following formats: 90 becomes 0:01:30, 90:00 becomes 1:30:00, 0:0:65 becomes 0:01:05, etc.
  4. Temperature, Humidity (or any control loop): This is a control loop, configurable with the following parameters:
    • EN: Enable the loop for this step.
    • Set Point: The temperature/humidity to go to during this step.
    • GS: Enable Guaranteed Soak for this step; this prevents the duration timer from counting down until the process value is within the deviation set in the program details section.
    • Rate: This parameter is only visible if the step is set to have a Ramp Rate; it specifies the rate at which the working set point will change in order to achieve the specified set point.
    • Mode: This parameter is only visible if the final steps end checkbox is selected; it specifies what each loop (Temperature, Humidity) will do when a program ends.
      • User: Run the constant set point.
      • Hold: Hold the last set point that the program was at.
      • Off: Disable the loop. This should not be used as the loop will need to be manually re-enabled.
  5. Time Signals: This button will show the settings for each available time signal.
    • NC: No change; do not change the state of this time signal.
    • On: Turn the time signal on.
    • Off: Turn the time signal off.

7.3.3 Program Preview

When a program is being created (or a program is loaded into memory), the Web Controller renders the steps of the program and displays them in a graphical form as illustrated in the following figure. The conditions prior to starting a program are assumed to be 0 degrees and 0%RH.

F4T program edit page preview

Description of elements on the graph:

  1. Program Step: The X axis is the program step number.
  2. Step Type: The type of each program step.
  3. Preview Legend: The legend for the preview graph.

8.0 Run/Stop Page

The chamber has three operation modes which can be managed via the Run/Stop page. These are Standby, Constant and Program, all displayed as individual panels. In a Standby mode, the chamber is off. In this mode, the Standby panel will have a check mark in the checkbox. The "Stop Operation" button in the Standby panel can be used to stop a running program thereby causing the chamber to be in a standby mode. The "Stop Operation" button can also be used to stop the chamber from running in a constant mode.

The Program panel has more operation modes. A running program can be paused via the "Pause" button; it can be resumed via the "Continue" button. Program's instructional steps can be stepped through using the "Next Step" button. A new program can be loaded via the drop-down menu in the Program panel.

Run/Stop page

Description of the chamber's operation state:

  1. Alarm Panel: This panel is only shown when there is an active alarm. No other controls on this screen will function until the alarm(s) have been cleared at the chamber.
    • Clear Alarms: Pressing this will clear all alarms for which the condition that triggered them has been resolved. If an alarm cannot be cleared the web controller will state which alarms could not be cleared.
  2. Active Mode: The checkbox in the top right of each panel denotes which of the modes is currently active.
  3. Standby Panel: This panel indicates that the chamber is not running.
    • Stop Operation: Pressing this button will put the chamber into standby mode.
  4. Constant Panel: This panel indicates that the chamber is running a constant set point. This Panel is not accessible for the account type "User".
    • Run Constant Mode: Pressing this button will put the chamber into constant mode.
  5. Program Panel: This panel indicates that the chamber is running a program.
    • Program: This drop down selects which program to run.
    • Start Step: This drop down selects which step the selected program will be started on.
    • Run Program Mode: Pressing this button will start the program selected on the Program drop down on the selected Start Step.
    • Pause: Pressing this will pause the running program.
    • Continue: Pressing this will cause a paused program to resume execution.
    • Next Step: Pressing this will force the running program to advance to its next step.

Executing a new program from the Standby or Constant mode:

  1. Ensure the chamber is in Standby or Constant Mode.
  2. Click the Program list in the Program panel and select a new program from the list.
  3. Click the "Run Program Mode" button.

Executing a new program while Chamber is in Program Mode:

  1. Click the "Stop Operation" button in the Standby panel.
  2. Click the Program list in the Program panel and select a new program from the list.
  3. Click the "Run Program Mode" button.

9.0 Network Page

If there are other controllers (using ESPEC Web Controller software) on the network, the Web Controller will detect and display them on the Network page, showing their current operation mode and status. The display is available in Panel view or List view, as shown in the following figures. In Panel view, each controller (chamber) is displayed as a panel identifiable by its hostname. Each panel directly links to that controller and is accessible via a mouse click. In List view, each chamber is listed by its hostname. It also contains additional information that includes program name and loop(s) operation. Each chamber on the list can be accessed by clicking on its hostname or anywhere along the row of that hostname. All user types as outlined in Section 1.1 can access the Network page.

Panel view

List View

Each panel is directly linked to a controller (chamber) with a unique Web Controller of its own. Thus, each will require a user to log in to control the chamber.

Network edit view

The layout and contents of either the Panel or List view may be edited:

  1. To turn on the edit mode, click on the menu page in the locations bar in the upper-right corner of the Network page and select "Enable Layout Editing" from the pop-up menu.
  2. Rearranging Chamber Location
    • Panel View: Each chamber may be rearranged or relocated on the grid by applying a drag-and-drop method. It can be resized using the arrow button on the bottom-right corner. To relocate a chamber on the grid, click on the menu in the locations bar and select "Enable Layout Editing" from the pop-up menu; click and drag a panel to a new location. Click and drag the corner of the panel to resize it. The grid will also expand to accommodate the changes. The new setting must be saved by selecting "Save Layout Changes" in the pop-up menu in order for it to take effect on the next display.
    • List View: Any chamber on the list may be relocated by using a drag-and-drop method. To relocate a chamber on the list, click on the menu in the locations bar and select "Enable Layout Editing" from the pop-up menu; click and drag a desired chamber to a new location on the list. The new setting must be saved by selecting "Save Layout Changes" in the pop-up menu in order for it to take effect on the next display.
  3. Removing Chambers
    • To remove a chamber from the grid, confirm that the plus (+) sign is visible next to the menu in the locations bar; if not, turn on the "Enable Layout Editing" from the menu. Hover the mouse pointer to a desired chamber and click on the notepad icon in the upper-right corner of the chamber (in Panel view) or to the right of the chamber's hostname (in List view); click Delete in the pop-up window and click Yes to confirm the action. To cancel the operation, click Close.
  4. Adding New Chambers
    • To add a new chamber, confirm that the plus (+) sign next to the menu on the locations bar is visible; if not, turn on the "Enable Layout Editing" from the menu. Click the plus (+) sign and select Add Chamber. In the pop-up window, enter the chamber's hostname and/or IP address and press Enter. If the Web Controller can resolve the hostname or IP address, the chamber will be visible on the grid. Note: Only compatible chambers will be detected and added onto the grid; generally those that were detected earlier and were removed from the grid.
  5. Saving a New Configuration of the Grid
    • Any changes done on the grid must be saved so that they can take effect on the next display. To save the setting of the grid, click the menu in the locations bar and select Save Layout Changes.

Starting with Web Controller version 2.4, a support of network link to the old Web Controller has been added. This feature allows a user to join any old Web Controller on the network group, as depicted in the following figure. Information needed for the old Web Controller to join the network is its IP address and/or hostname.

Join old Web Controller in the network group

To access the old Web Controller, simply click on its link. As illustrated in the above figure, two old Web Controllers have joined the network. One Web Controller in the network has issues as indicated by its Error status. Thus, the network page is quite useful at providing a quick preview of the status of all the Web Controllers on the network.

10.0 Setup Page

The Setup Page can only be accessed by an administrator to apply different settings to the Web Controller. All configuration settings are accessible on this page, including network and e-mail settings. This section is divided into subsections to provide detailed explanation on each of them. The following figure depicts the main Setup Page. Configuration tabs are available on the left pane. If any one of them is clicked, its panel will be displayed on the right.

Setup page

10.1 Hostname & Network Configuration

By default, the Web Controller uses DHCP for its network configuration, with an IP address assigned by the DHCP server. It is possible to configure and assign a static IP address for the Web Controller so that it will always have (or use) the same IP address even after it goes through a power recycle; the advantage being that the Web Controller can always be found by its IP address.

A static network configuration can be accomplished by un-checking the DHCP box and entering a desired IP Address, with the appropriate Netmask, Gateway and DNS values. The Web Controller will check and validate the new network configuration for the correct format.

A unique and descriptive hostname for the Web Controller may be configured by editing or entering a new hostname in the Host field. These settings will take effect immediately after the Apply button is clicked. However, it may require some time for the Web Controller to resolve the new configuration. It will require reopening a new browser to access the Web Controller by its new hostname.

Setup page: network configuration

10.2 Alarm Recipients & E-Mail Server Settings

The Web Controller has a feature to notify the operator as an e-mail alert about the chamber's condition, such as when an alarm went off. To set up an e-mail notification, enter an e-mail address in the Alert Addresses field and click Apply. The "Send Test Message" button can be used to test sending a message to that e-mail address. Multiple e-mail addresses can be used for alert notifications sent out to different recipients. However, each line in the Alert Addresses field may only contain one e-mail address. To enter multiple e-mail addresses, click and drag the lower-right corner of the Alert Addresses field downward to expand the field for multiple e-mail entries; then enter one e-mail address per line. The SMTP password (in the SMTP Password field) is only required when setting a new password.

Setup page: email configuration

10.3 Logging Configuration

The Web Controller can collect and log data at a desired interval (or frequency). This section allows the user to change the logging frequency, clear the logs, configure automatic log backup, and manage connected USB drives.

Setup page: Data logging configuration

Description of Logging Configuration:

  • Update Sample Frequency: The "Sample Frequency" controls how often the system will log the current conditions of the chamber.
    1. Enter the desired sample frequency; time is in seconds, range is 10 to 600 (10 minutes).
    2. Press the "Apply" button.
    3. Reboot the web controller.
  • Clear Data Log: Delete all data on the web controller.
    1. Press the "Clear Log" button.
  • Automatic Backup: Setup an automatic backup routine so that in the event of a system failure data is not lost.
    1. Select the desired "Backup Mode".
    2. Select the desired Backup Frequency.
    3. Additional settings for the backup modes:
      • USB: Plug a USB drive that is formatted to FAT/ext2/3/4 into a USB port on the web controller.
      • SAMBA: Fill out the necessary connection information:
        • Share Path: The connection details for the server, the share name, and any sub folders; example: \SERVER\SHARE\FOLDER1\FOLDER2
        • User Name: The user name for authenticating with the server.
        • Password: The password for authenticating with the server.
        • Domain: The domain for authenticating with the server.
    4. Press the "Test Backup" to ensure it is working properly.
    5. Press the "Apply"
  • Eject USB: If a USB drive is plugged for use with the automatic backup it must be ejected properly or risk data loss. If no USB drive is present on the system the "USB Media" section will not be present. There is a shortcut for doing this embedded HMI software if a monitor is connected at boot, see Chapter 17.
    1. Press the "Eject" button on the USB drive you wish to eject.

10.4 Firmware Update

ESPEC Web Controller is designed with the ability to continually receive improvements and updates in the form of a Firmware Update to provide bug fixes or upgrade the software with new features. Starting with version 2.5 firmware updates are installed using the "Stand Alone" mode of mender.io.

10.4.1 Apply Firmware Update

ESPEC Web Controller customized for TERUMO BCT chamber supporting English and Spanish user interface comes with a software update to provide TERUMO with options to perform a software update to restore the Web Controller. The update package was included in the software package with the delivery of the chamber. Firmware update can proceed as follows:

  1. Click the Firmware Update tab under the Setup menu.

  2. Click the Upload Firmware button.

    Setup page: Firmware update

  3. Click Browse to search for the update package (provided by ESPEC), called TerumoES-2.5.3.mender, and click Submit.

    Uploading firmware update package

  4. Upon completion of the firmware update, the system prompts for reboot (as shown below), which requires the user's action with Yes/No option. In order to complete the update, ESPEC Web Controller must reboot to use the updated software.

    Successful update

10.4.2 Network-Wide Firmware Update

This section does not apply to TERUMO BCT custom software since it is a stand-alone system. However, it is presented in completeness to illustrate the capabilities of ESPEC Web Controller firmware update options. With this feature, an update package can be pushed to all ESPEC Web Controller (referred to as device) on the network. The process is to upload a firmware image to the local device and then install it to all compatible devices that can be automatically found on the network. The procedure is outlined as follows:

  1. The user selects the firmware update file on there computer using the "Browse" button then uploads the image to the server after pressing "Submit":

    bfw_upload.png

  2. The firmware will be uploaded to the system:

    bfw_upload_progress.png

  3. The system will search the network for other web controller devices that also need the firmware update:

    bfw_search.png

  4. Once all eligible systems have been found the user will be promted to install the firmware, select "yes" to proceed:

    bfw_confirm.png

  5. The firmware will now be flashed to all of the eligible systems, this process will take a while and the browser must be left open to this page for it to succeed.

    bfw_flash_progress.png

  6. Once all of the eligible systems have been flashed the user will be prompted to reboot all of the systems:

    bfw_reboot.png

  7. Once the system(s) have rebooted a system check is performed to ensure correct operation, if that check fails or the system does not reboot the old firmware will be automatically restored on the next reboot.

10.4.3 Rollback Firmware

This section describes how to revert the system back to the previous version of the firmware. The procedure is as follows:

  1. The system will prompt for confirmation prior to rolling back the firmware version, select "Yes" to proceed.
  2. The system firmware will be set to the previous version after a reboot, the user is prompted to reboot the system now. Select "Yes" to reboot and start using the old firmware.

10.5 Time Signal Names

This section will allow custom names to be applied to each time signal.

Setup page time signal names

However, the custom Web Controller for TERUMO BCT chamber has both time signals already contain custom labels: Hold Phase and Low Humidity. They also are linked directly to the Spanish translation. The rest of the time signals are designated with specific names and their corresponding Spanish translation. For this reason, if these time signals are renamed, translation must also be updated in Spanish. Refer to Section 17.4 for detail on the translation procedure.

10.6 REST API/TCP Forwarder Configuration

The REST API and TCP tab provide an advanced configuration to control the Web Controller. REST API allows for a standard universal way to interact with the Web Controller and chamber. It supports three security modes: Off, No Authentication and HTTP basic Authentication. The security of the REST API can be adjusted, in addition to enabling or disabling the TCP Forwarder. The TCP forwarder allows a direct access to the chamber controller via the Web Controller. The REST API may be browsed by disabling authentication and navigating to "/api/v1.0/" and following the various URIs given at each address. Note: Each controller has its API and therefore a TCP forwarder for each controller must be configured separately.

Rest API configuration

Description of the REST API security modes:

  • REST API: This allows for a standard universal way to interact with the Web Controller and chamber. Refer to Section 14.1 (14.1 REST API) for documentation. It supports three security modes:
    • Off: Do not allow any access.
    • No Authentication: Allow all access.
    • HTTP Basic Authentication: Use HTTPs built in basic authentication.
  • TCP Forwarder: This allows direct access to the chamber controller through the Web Controller. Refer to Section 14.2 (14.2 TCP Forwarder) for documentation.

10.7 User Account Management

The account management tab allows the system administrator to manage user accounts and access privileges to the controller, with three different account types: User, Technician and Administrator.

User account management

Detailed Description:

  • Account Creation: To create a new user account, use the following steps.
    1. Click on the "Add User" button.
    2. Enter the username.
    3. Enter the password (twice).
    4. Select the correct account Type.
    5. Click the Apply button.
  • Account Removal: To remove an account use the following steps.
    1. Click the X button on the row for the user to be removed.
    2. Click the Apply button.
  • Account Modification: To adjust the users password or account type, use the following steps.
    1. Update the password twice if desired.
    2. Update the account type if desired.
    3. Click the Apply button.
  • Idle Auto Logout Time: Set the amount of time a user must be idle before they are automatically logged out. The default of 1 year mimics the behavior of previous versions of the software.

10.8 Set Chamber Date/Time

To keep an accurate data log, it is important to have the correct date and time on the Chamber Controller, since this is where data is being collected. The date/time can be synchronized with the user's local device (such as a PC, tablet or phone) that is being used to access or control the chamber via the Web Controller. This page offers a manual configuration of the date/time on the chamber or the Web Controller. Since data collected from the chamber will have a date/time stamp of the chamber controller, it is not necessary for the Web Controller or Network Time Protocol server to have the correct date/time. However, correct date/time on the server and chamber is desirable.

Setup page date and time

10.9 Macro Editor

The macro editor allows the creation of custom actions that may be triggered either manually or when the chamber has reached a specified state. Section 12.0 discusses in detail the application of the macro editor. The following figure depicts a typical macro editor setting with its script loaded and enable. Refer to Chapter 17 on how to upload a macro editor file.

Macro editor setup page

10.10 External Source Editor

Through the external source editor, additional parameters from external devices can be read and written to the Web Controller. Communication interface currently supported is Modbus TCP/RTU. New parameters may be uploaded from an external source and written to the Web Controller via the "Upload" button. New parameters may be created via the "New" button. Current parameters on the Web Controller may be download via the "Download All" button. We can also restore parameters to the Web Controller via the "Restore" button. Section 13.0 discusses in detail the application of external source editor. The following figure depicts a typical application of external source editor (for ESPEC SCP-220 PLC).

Setup page external source editor

10.11 Chamber Interface Configuration

The Chamber Interface Configuration tab can be used to configure the Web Controller to communicate with the attached chamber. The following figure depicts a typical interface configuration for Watlow F4T. Four different controllers currently supported by ESPEC Web Controller, version 2.5, are: ESPEC P300/SCP-220, Watlow F4 and Watlow F4T. There are two different ways to configure the Web Controller to communicate with the chamber and its controller:

Setup page chamber interface configuration

  • Quick Chamber Configuration: This configuration method can be done by entering the specific parts of the chamber model and controller type, including various options.
    1. Click and select the appropriate model line from the Model drop-down list.
    2. Click and select the control type, such as Temperature or Temperature and Humidity.
    3. Click and select the appropriate controller from the Controller drop-down list.
    4. Watlow F4T Only: This controller may be connected to via Ethernet. If that is desired select the "TCP" option for the "Interface Type" and enter the following information:
      • Network: The hardware has two ethernet interfaces, we must select which one the Watlow F4T is connected too. The default is "LAN: Chamber Private Network" as Watlow F4T chambers will ship this way from the factory:
        • WAN: User Network: The customers network, if this is used the F4T will need to be configured for static networking and connected to the same network as the web controller.
        • LAN: Chamber Private Network: A private network internal to the chamber, this is the only type will ship from the factory. The private network and customers network are kept completely isolated with exception for when connected to a single Watlow F4T, in that case the following services (port) are forwarded from the web controller to the Watlow F4T:
          • Modbus TCP:502
          • SCPI TCP:5025
          • Watlow Composer TCP/UDP:44819
      • IP Address: The IP address of the Watlow F4T, this must be assigned statically.
      • CIDR (Netmask): The sub-net mask for the private network.
      • Web Controller private IP Address: This will be automatically assigned to the first available address in the range calculated by the IP Address and CIDR (Netmask) fields when the Network field is LAN: Chamber Private Network.
    5. Other options associated with the chamber and controller operation can be selected from the checkbox under the Options menu.
    6. Click the Apply button to apply the current settings.
  • Configuration File: This is used to upload and download custom configurations that cannot be made using the Quick Chamber Configuration.

Your chamber requires a custom configuration file. Refer to Chapter 17 on how to upload this configuration file.

11.0 Programming Interfaces

The Web Controller provides several interfaces for other software to read and write the parameters from and to the chamber.

11.1 REST API

The REST API may be browsed by disabling authentication and navigating to “/api/v1.0/” and following the various URIs given at each address. For full documentation see: https://bitbucket.org/especnorthamerica/especweb/wiki/RESTful_API_documentation

11.2 TCP Forwarder

This feature allows a user to connect directly to the controller through the web server. As each controller has its own interface they must be described separately.

11.2.1 Communication Protocol for the Watlow F4T

The communication protocol provided for the Watlow F4T is Modbus TCP port 502. Due to its slow performance, the Modbus TCP interface is not recommended to use for communicating with the Web Controller. The Watlow F4T's own Modbus TCP interface should be used instead.

12.0 Macros

Macros are a series of scripted actions that can be triggered automatically by the chamber's state or manually by a user. These macros can conduct various tasks ranging from sending email notification to a user regarding test completion to synchronization of operation between multiple chambers. A new macro script can be created by clicking on the New button in the macro editor panel, refer to Section 13.0 ([13.0 Macro Editor] (#markdown-header-139-external-sources)). Various parameters can be configured as shown in the following figure. Various actions that can trigger a macro script will be explained in the following subsection.

Macro editor page

12.1 Triggers

A macro may be triggered by any of the following actions:

  • Manual Trigger Only: The macro must be manually triggered by a user or api request.
    • Prompt User: When enabled the user will be prompted for input when triggering this macro.
    • Prompt Text: The text that the user is presented with the prompt.
    • User Privilege: The minimum account type a user has to be in order for them to trigger this macro.
  • Always Trigger: The macro will run every time; this is not recommended.
  • Operation Mode Change Trigger: The macro will run when the operating mode has changed to meet the specified criteria.

    • Condition: How did the operation mode change?
      • ANY: Any change involving the specified mode will cause a trigger.
      • Changed from: Any time the chamber was running the specified mode but no longer is will cause a trigger.
      • Changed to: Any time the chamber was not running the specified mode but now is will cause a trigger.
    • Mode: The operating mode to check against.
    • Example trigger for constant mode start:

      Operation mode change trigger

  • Date and/or Time Trigger: The macro will run at a specified time. When the date/time matches the configured "Month", "Day of the Month", "Year", "Day of the Week", "Hour", "Minute", and "Second" the macro will fire.

    • Example trigger for running a macro once a minute:

      Date and/or time trigger

  • Program Change Trigger: The macro will run when a programs execution state has changed.

    • Condition: How did the program state change?
    • Program Number: When the specified program state change condition is met and this program number is involved then trigger.
    • Step Number: When the specified program state change condition is met and this program step number is involved then trigger.
    • Example trigger for running a macro when program 1 step 5 completes:

      Program change trigger

  • Alarm Change Trigger: The macro will run when the state of an alarm has changed.

    • Condition: Specifies how the alarm state has changed ie: cleared, triggered, either
    • Alarm: The specific alarm to monitor.
    • Example trigger for running a macro if the chamber overheats:

      Alarm change trigger

  • Time Signal Change Trigger: The macro will run when the state of a time signal has changed.

    • Condition: Specifies how the time signal state has changed ie: enabled, disabled, either.
    • Time Signal: The specific time signal to monitor.
    • Example trigger for running a macro when time signal 1 is enabled:

      Time signal change trigger

  • Control Loop Parameter Trigger: The macro will run when a control loop parameter has changed.

    • Control Loop: The control loop to monitor.
    • Parameter: The parameter of the control loop to monitor.
    • Operation: The type of change to look for.
    • Value: The value to compare the parameter against.
    • Example trigger for running a macro when chamber reaches 100 degrees:

      Control loop parameter trigger

  • External Equipment Source Trigger: The macro will run when an external source value has changed.

    • External Source: The external source to monitor.
    • Operation: The type of change to look for.
    • Value: The value to compare the source against.
    • Example trigger for running a macro when the external source value changes:

      External equipment source trigger

  • Custom Trigger: The macro will run when a user's specified template evaluates to true. For full documentation on what is available when written templates see the help on the server itself as each install will be different.

12.2 Available Operations

A macro may consist of any combination of the following operations:

  • Email: Send an email with a custom message/subject/attachment. The attachment will consist only of logged chamber data in csv format.

    Email attachment

    • Recipients: Email addresses for the recipients of the email; for multiple addresses use one address per line. If this is left empty the configured alert addresses will be used.
    • Subject: Subject of the email to be sent. This field allows templating.
    • Attach Log Data: The data to attach as a csv file.
      • File Name: The file name to give the data when there is some. This field allows templating.
    • Body: The message body; when html is used this is automatically detected and the message is sent as an html message. This field allows templating.
  • FTP: Upload log data in csv format to a standard ftp server/encrypted ftp server. Note that SFTP (secure shell file transfer protocol) is not supported at this time.

    Upload custom log file

    • Server: The host name or ip address of the ftp server.
    • User: The name for the user who will be authenticated with the server.
    • Password: The password for the given user; if this is not provided the stored password will be used.
    • Require TLS: Force the connection to the server to be encrypted with TLS.
    • Operation: What action should be taken if a file already exists?
      • Append: Append the new data to the end of the file on the server.
      • Overwrite: Remove the existing file and replace it with the new one.
    • Path: The path that the data file will be stored at on the server. This field allows templating.
    • Data To Send: The query used to generate the csv data that will be placed on the server.
    • File Name: The name of the file that the data will be saved to.
  • SAMBA: Upload log data in csv format to a windows network server.

    Upload via Samba

    • Server: The hostname or IP address of the windows/samba server.
    • User: The name for the user who will be authenticated with the server.
    • Password: The password for the given user; if this is not provided the stored password will be used.
    • Workgroup: The workgroup that the user belongs to.
    • Share: The name of the share that the data will be saved on.
    • Operation: What action should be taken if a file already exists?
      • Append: Append the new data to the end of the file on the server.
      • Overwrite: Remove the existing file and replace it with the new one.
    • Path: The path that the data file will be stored at on the server. This field allows templating.
    • Data To Send: The query used to generate the csv data that will be placed on the server.
    • File Name: The name of the file that the data will be saved to.
  • HTTP: Issue an http request to a server.

    Using GET via HTTP

    • Request: The URI and type of request that will be issued. There are three parts to this field:
      • Method: The HTTP method to be used when performing the request. The available methods are: GET, HEAD, POST, PUT, DELETE, PATCH.
      • URI: The address that this request will be issued against. This field allows templating.
      • Params: The URL encoded params that are added to the end of the URI. Each key/value field allows templating.
    • Authentication: The authentication method to use with the request. Available options are: "No Authentication", "HTTP Basic Authentication", "HTTP Digest Authentication".
    • Headers: The headers to be used with the request.
    • Load Log Data: The logged chamber data made available to the template for the request body.
    • Body: The request body. The field allows templating.
  • Wait: Wait for a specified time or for an additional trigger to occur.

    Using WAIT via HTTP

    • Wait For Type: The type of wait this operation is. The available options are: "Delay Time", and "Chamber Condition"
    • Delay Time: The amount of time to delay when Wait For Type is Delay Time.
    • Trigger: The condition that the chamber must be in order for the delay to finish when Wait For Type is Chamber Condition. This field behaves exactly the same way as the macro trigger.
  • Return JSON: Respond to the request that triggered this macro with JSON formatted data.

    JSON file and its format

    • Load Log Data: The data to be made available to the template for the response body.
    • Body: The response body. This field allows templating.
  • Return CSV: Respond to the request that triggered this macro with log data in CSV format.

    CSV file and its format

    • Data To Send: The query used to generate the csv data that will be returned as a csv file.
    • File Name: The name of the file that is returned as a response.
  • Message: Flash an alert on the user interface for the next person access the web interface.

    Macro Message.PNG

    • Body: The message to present to the user. This field allows templating.

12.3 Templates

Some fields allow templates to be used to generate data dynamically based on the current chamber state. These templates use the jinja2 template engine; a basic overview is provided here but for full details see the jinja2 docs website: http://jinja.pocoo.org/docs/2.9/templates/#synopsis. These fields all have additional controls on the right side as shown below:

Template fields versus standard fields

  • The Recipients field shown here is an example of a non template field.
  • The Subject field shown here is an example of a template field.
    • The eye in the top right of the field will render the field with the current chamber state for debugging.
    • The question mark will open a dialog with full information on how templating works and what data is available to that specific field. Use this dialog for documentation as what is available varies by chamber configuration.
    • When typing in template fields autocomplete is enabled and will try to provide suggestions for the data available.

12.3.1 Displaying Variables

To insert data into a string simply enter the data name inside the double curly brackets like this: {{ variable }}. Here is an example of data insertion and its format. Multiple data insertion must be entered in separate curly brackets.

Example: Data insertion template

The chamber mode is: {{ new.operations.mode }}
The temperature is: {{ new.loops[0].processValue.air }}{{ new.loops[0].units }}

Example: Results

The chamber mode is: Constant
The temperature is: 100°C

12.3.2 Filters

Filters are used to apply specific formatting to variables by adding a pipe followed by the filter name when displaying a variable {{ variable | filter }}. In addition to the built-in filters, documented on the jinja2 docs website, several custom ones are included here for reference:

  • datetime: Convert a datetime object into a nicely formatted string.
  • timestamp: Convert a datetime to an epoch (seconds since 0:00:00 Jan 1, 1970).
    • Arguments: None
    • Example: {{ new.operations.datetime | timestamp }}
  • tojson: Convert an object to json.
    • Arguments: None
    • Example: {{new | tojson}}

12.3.3 Flow Control

Loops and "if statements" may also be used to conditionally render elements using the curly bracket and percent characters {% if condition %} Condition is True {% endif %}

If statements:

    {% if condition %}
        contents
    {% endif %}

    {% if condition %}
        contents
    {% else %}
        contents
    {% endif %}

    {% if condition %}
        contents
    {% elif condition %}
        contents
    {% else %}
        contents
    {% endif %}

Loops:

    {% for item in items if condition %}
        contents
    {% endfor %}

    {% for item in items %}
        contents
    {% endfor %}

12.3.4 Chamber State Variables

The following is a list of possible chambers state variables and their meaning.

  • old and new: State of the chamber before and after the database was updated; both have the exact same structure.
    • Type: Dictionary
    • keys:
      • alarms: A list of chamber alarms and their state.
        • Type: List
        • keys for each element:
          • controller: The database id of the controller this alarm is on. type: int
          • id: The database id for this alarm. type: int
          • name: The name of the alarm. type: string
          • number: The number of the alarm. type: int
          • triggered: The state of the alarm. type: bool
      • controllers: A list of chamber pid controllers and their state.
        • Type: List
        • keys for each element:
          • datetime: The current datetime. type: datetime
          • program: The currently running program. type: int
          • program_details: Miscellaneous controller specific program status information. type: string
          • program_name: The name of the currently running program. type: string
          • program_step: The currently running program step number. type: int
          • program_time: The time remaining on the program. type: string
          • program_time_step: The time remaining on the current program step. type: string
          • status: The current controller run status. type: string
      • events: A list of time signals (events) and their status.
        • Type: List
        • keys for each element:
          • N: The number for the time signal on the controller. type: int
          • controller: The database id of the controller that this time signal is on. type: int
          • id: The database id for this time signal. type: int
          • manual: When true this time signal is user settable. type: bool
          • name: The name of the time signal. type: string
          • status: The state of the time signal.
            • type: Dictionary
            • keys:
              • constant: The constant mode state of the time signal. type: bool
              • current: The current state of the time signal. type: bool
          • valid: If this is False error occurred while reading this from the controller. type: bool
      • external_sources: A list of values read in from external equipment sources.
        • Type: List
        • keys for each element:
          • value: The current value of the external source. type: varies
          • name: The name of this external source. type: string
          • units: The units of this external source. type: string
      • loops: A list of pid control loops and there status.
        • Type: List
        • keys for each element:
          • N: The number for the pid loop on the controller. type: int
          • controller: The database id for the controller that this pid loop is on. type: int
          • deviation: PTCON/Cascade pid loops only. The allowable difference between the product and air process values.
            • Type: dictionary
            • keys:
              • positive: The allowable positive difference between the product and air processValues. type: float
              • negative: The allowable negative difference between the product and air processValues. type: float
          • enable: State of the control loop on/off for further details see mode.
            • Type: dictionary
            • keys:
              • constant: The constant mode settings for this parameter. type: bool
              • current: The current state of this parameter. type: bool
          • enable_cascade: PTCON/Cascade pid loops only. State of the product control mode for the loop.
            • Type: dictionary
            • keys:
              • constant: The constant mode settings for this parameter. type: bool
              • current: The current state of this parameter. type: bool
          • id: The database id for this pid loop. type: int
          • mode: The current control mode of the loop.
            • Type: dictionary
            • keys:
              • constant: The constant mode settings for this parameter. type: string
              • current: The current state of this parameter. type: string
          • name: The name of the pid loop. type: string
          • power: The pid loop output power.
            • Type: dictionary
            • keys:
              • constant: The constant mode settings for this parameter. type: float
              • current: The current state of this parameter. type: float
          • processValue: The current conditions inside the chamber for this pid loop.
            • Type: dictionary
            • keys:
              • air: The current conditions for the air inside the chamber. type: float
              • product: PTCON/Cascade pid loops only. The current conditions of the product inside the chamber. type: float
          • range: The allowable control range of the pid loop.
            • Type: dictionary
            • keys:
              • max: The maximum setValue of the pid loop. type: float
              • min: The minimum setValue of the pid loop. type: float
          • setValue: The condition the pid loop will attempt to attain.
            • Type: dictionary
            • keys:
              • air: PTCON/Cascade pid loops only. The current target for the air inside the chamber. type: float
              • product: PTCON/Cascade pid loops only. The current target for the product inside the chamber. type: float
              • constant: The constant mode settings for this parameter. type: float
              • current: The current state of this parameter. type: float
          • units: The units for the pid loop parameter. type: float
          • user_settable: Specifies if the loops parameters may be modified by the user. type: bool
          • valid: When this is False there was an error reading the state from the chamber. type: bool
      • operations: The operation status of the chamber.
        • Type: Dictionary
        • keys:
          • datetime: The current datetime of the chamber. type: datetime
          • mode: The current run mode of the chamber.
          • program: The current program state of the chamber.
            • Type: Dictionary
            • keys:
              • name: The name of the currently running program. type: string
              • number: The number of the currently running program. type: int
              • step: The current running program's current step. type: int
              • time_end: The estimated end time of the currently running program
              • time_step: The remaining time in the current program step.
              • time_total: The remaining time of the program.
      • programs: A list of programs on the chamber.
        • Type: List
        • keys for each element:
          • controller: The database id of the controller that this program is on. type: int
          • id: The database id of this program. type: int
          • name: The name of this program. type: string
          • number: The number for this program in its process controller. type: int
      • refrigerators: A list of the refrigeration systems and their status.
        • Type: List
        • keys for each element:
          • controller: The database id of the controller that this refrigerator is on. type: int
          • id: The database id of this refrigerator. type: int
          • mode: The current mode of this refrigerator. type: string
          • valid: When this is false an error occurred reading the state from the chamber. type: bool
  • query: The results of a data log query.
    • Type: Dictionary
    • keys:
      • datetime_success: The datetime of the last successful operation accessing the database. type: datetime
      • results: The results of the data log query on "HTTP" and "Return JSON" operations. This is formatted as a list of dictionaries for each row with keys corresponding to the requested columns.
  • request_args: The arguments passed to the macro by a user triggered macro.
  • results: The results of the http request. If the response body was json then this will be a dictionary; if it was anything else this will be a string.

12.4 Included Examples of Macros

The Web Controller will be shipped with three examples of macros.

  1. Hourly upload data logs to a windows (SAMBA) server.
  2. Hourly upload data logs to a FTP server.
  3. Email user at program end.

13.0 External Sources

External equipment sources are other devices that can communicate using an industry standard protocol such as Modbus TCP. The Web Controller can display or log the configured parameters read from these devices. Once data has been read it is then passed to a value parser so that complex structures may be properly handled.

External source editor

13.1 Available Protocols

The Web Controller currently supports Modbus RTU and TCP protocol communication. Other protocol types will be included in the future release of the Web Controller.

13.1.1 Modbus RTU/TCP

Currently the Web Controller can only read data from Modbus devices that use only input and holding registers. The following parameters are required:

  • register: The Modbus register to read from.
  • address: The address of the Modbus device to read from. This is required for TCP in case in Modbus gateway is being used.
  • type: The type of register to be read from and how it should be interpreted (data type).
  • count: The number of registers to read from.
  • low_word_first: The order of 32bit Modbus registers.
  • scalar: The multiplication factor for reading fixed point numbers.

The following figure illustrates how these parameters are handled.

Parameter information

13.2 Value Parser(s)

After data has been read from a device, the Web Controller will first parse the data before storing it. The following list describes how parsing is done by the Web Controller.

  • Display Name: This is the name used to display the data in the web server's status bar.
  • Display Units: This is the units that will be used to display the data in the web server's status bar.
  • Display in Sidebar: Checking this will cause the data to be displayed in the status bar.
  • Data Formatter: In cases where the raw data is not in the correct format there are a few methods available to correct that:
    • Lookup Table: Use the data as a key in a dictionary lookup.
    • Compare with true/false lookup: See if the data meets a specified condition and choose a formatted value for each case.
    • Override Value: Ignore the read value and specify a new one.
  • Data Type Conversion: Convert (cast) the value from one data type to another, supported data types: boolean, integer, float, string.
  • Logging: Specify if the data is to be logged and if it is what type of data column it will need to be.
  • Data Table Injection: Inject the data into the chamber state database back-end; to make the data look as if its one of the natively supported structures (control loop, time signal, alarm, etc.). This is an advanced feature and contact with support may be needed to use it.

14.0 Network Configuration by Program Names.

Network connection can be configured via a series of special program names. These programs must contain only the default single step, and have the following names in the following order.

Once the web controller reads the programs that meet the criteria shown in sections 17.1 thru 17.4 the network settings will be applied and the programs will be deleted. Allow at least 2 minutes for this to happen after putting the program names in. If the program names do not get deleted ensure the programs meet the listed criteria, if they do then communication between the web controller and chamber controller may not be working.

14.1 Watlow F4T Static Networking

Static networking format for the Watlow F4T based chambers.

Program # Format Example
n "..STARTNET" "..STARTNET"
n+1 ".A[IP Address]" ".A192.168.0.83"
n+2 ".M[Net Mask]" ".M255.255.255.0"
n+3 ".G[Gateway Address]" ".G192.168.0.1"
n+4 "..ENDNET" "..ENDNET"

14.2 Watlow F4T DHCP Networking

DHCP networking format for the Watlow F4T based chambers.

Program # Format Example
n "..STARTNET" "..STARTNET"
n+1 ".DHCP" ".DHCP"
n+2 "..ENDNET" "..ENDNET"

15 Calibration on HMI Touchscreen Panel

The following sections outline the general procedures how to configure and calibration the touchscreen.

15.1 Touchscreen Calibration.

Resistive touch screens must be calibrated so that the elements the user touches match what is pressed on screen. The Automatic Calibration (Item 2) should be used as it is the simplest and most accurate calibration method. All other settings are currently available in case the automatic calibration option does not work as intended.

HMI Application Touch Screen Calibration

  1. Close/Cancel: Close the Touch Screen Calibration menu without saving any of the options.
  2. Run automatic calibration: Start the automatic calibration routine, the procedure for this is as follows:
  3. Device: The name of the touch controller to be calibrated.
  4. Horizontal Scale: The scaling factor used to ensure the detected touch range is the same width as the screen.
  5. Horizontal Offset: The offset used to ensure that the detected touches are not off by a set number of pixels.
  6. Vertical Scale: The scaling factor used to ensure the detected touch range is the same height as the screen.
  7. Vertical Offset: The offset used to ensure that the detected touches are not off by a set number of pixels.
  8. Test Settings Button: Apply settings for testing, the settings will be lost at power loss.
  9. Apply Button: Apply and save the settings so that the touch screen calibration settings will be used every time the HMI application starts.

Calibration procedures:

  • Automatic Calibration procedure: This is the recommended procedure:
    1. Start the procedure using the Run automatic calibration button.
    2. Follow the on screen instructions and press each of the 4 points when instructed too. It is best to use a stylus for accuracy.
    3. Test that the calibrations are working as expected.
    4. Press the Apply Button (Item 9) to make the settings apply when the HMI application starts.
  • Manual Calibration procedure: This procedure is not recommended, however it may be necessary in some cases.
    1. Perform the calibration on the on the Horizontal parameters:
      1. Touch the screen about 1" from the left and right most edges of the screen:
        • If the cursor is towards the center of the screen from both touch points; increase the Horizontal Scale value.
        • If the cursor is towards the outside of the screen from both touch points; decrease the Horizontal Scale value.
        • If the cursor is on the left side of both touch points; decrease the Horizontal Offset value (negative numbers are fine).
        • If the cursor is on the right side of both touch points; increase the Horizontal Offset value.
      2. Press the Test Settings Button (Item 8)
      3. Repeat this step until the cursor is inline with the touch points over the extents of the screen, the cursor may be above or below the touch points, this will be fixed with Vertical parameters.
    2. Perform the calibration on the on the Vertical parameters:
      1. Touch the screen about 1" from the top and bottom most edges of the screen:
        • If the cursor is towards the center of the screen from both touch points; increase the Vertical Scale value.
        • If the cursor is towards the outside of the screen from both touch points; decrease the Vertical Scale value.
        • If the cursor is on the top side of both touch points; decrease the Vertical Offset value (negative numbers are fine).
        • If the cursor is on the right side of both touch points; increase the Vertical Offset value.
      2. Press the Test Settings Button (Item 8)
      3. Repeat this step until the cursor is inline with the touch points over the extents of the screen, the cursor may be left or right the touch points, this will be fixed with Horizontal parameters.
    3. Repeat steps 1 & 2 until the cursor matches where the user touched the screen.

15.2 Hidden Settings

There are several settings that are not present in the HMI Settings menus. These may be adjusted by navigating to special URLs via the URL bar.

URL Description
app://devtools Open Developer tools; used for debugging purposes.
app://enableosk Enable the on screen keyboard; enabled by default
app://disableosk Disable the on screen keyboard
app://enablemousetouch Enable all mouse events triggering a touch event, required for some touch screens
app://disablemousetouch Disable mouse events trigger touch events; disabled is default

16.0 Terumo BCT Customizations

As mentioned in the Introduction, many of the customizations requested (by TERUMO BCT) were added to the standard release of the Web Controller version 2.5.0. This chapter covers only the modifications that are not already in the standard firmware.

16.1 Clearing Faults/Alarms

Standard Web Controller functionality does not include the ability to reset chamber Alarms/Faults. This functionality has been added to the Run/Stop screen.

Run/Stop page

These details are also noted in the Run/Stop screen

A clearable fault/alarm is a fault/alarm that no longer meets the criteria that tripped the fault/alarm. For example, if a high temperature alarm is set to 80C and has been tripped but the temperature is now 79C, the fault/alarm is clearable. However, if the temperature is greater than 80C, the fault/alarm is not clearable from the Run/Stop page.

16.2 Electrical Power Loss Alarm

The F4T has been configured to automatically resume its profile if electrical power has been lost for less than 1 minute. If electrical power has been lost for more than 1 minute the system will not resume the profile and instead the alarm "Power loss during test" will be displayed. The "Power loss during test" alarm is triggered by a macro on the web controller.

Power Fail Alarm Macro Setup

16.3 Program Complete Message and Light Stack

The web controller and F4T programs have been configured to use time signal 7 "Program Complete" to reliably determine that a program has run until it was completed. For this to work correctly each profile must be configured to to enable time signal 7 only after all of the desired "normal" operations have been completed and leave it enabled after the profile is done.

16.3.1 Required Program Structure

The program structure and the added features were discussed in Chapter 7. It is presented here to emphasize the custom feature (not in the standard release).

Terumo Program.png

  • Step 1-2: "Program Complete" time signal 7 must be set to OFF for all "normal" steps of the program. In the above example this program is only two steps long however there could be up to 97 "normal" steps. Example program details:
  • Step 3: This must be a copy of the previous step (step 2 in this example) with the following modifications:
    • The duration should be no greater than 10 seconds.
    • The GS (Guaranteed Soak) parameter for Temperature & Humidity must off.
      • Guaranteed Soak works by pausing the duration timer while the difference between the temperature/humidity process value and set point is greater than the defined range as set in the Program Details section. See chapter 10.1.1.
    • Time signal 7 "Program Complete" has is set to ON.
  • Step 4: It is recommended that an End step is configured to ensure the chamber enters the desired operating mode once the program is complete. In this example we want the chamber to enter "Standby" so we enable the "Stop Chamber" check box. It is important to note that an End step is not sequential and will execute no matter the reason the profile has been stopped, because of this it must meet the following criteria:
    • Time Signal 7 "Program Complete" must set to "NC" (No Change).
      • If it is set to "ON" the program complete message and green light will flash no matter the reason the program ended.
      • If it is set to "OFF" the program complete message and green light will not flash.

16.3.2 Program Complete Message

After a correctly configured program completes a message will be displayed on the web controller interface, in addition too the green light on the light stack flashing. In order to clear both this message and disable the flashing light stack the user must acknowledge the program complete message by closing it with either with the X on the top right of the message box.

Terumo Program Comlete.PNG

17 Custom Configuration

The following sections provide a custom setup procedure of the Web Controller after it has been reflashed to restore the firmware. The configuration involves chamber interface configuration through the Setup Wizard, uploading the configuration files and updating the dynamic translation. The necessary information and files can be found in the SOFTWARE-ES folder that was distributed with the delivery of the chamber.

17.1 Chamber Interface Configuration

As stated in Section 2.4, before ESPEC Web Controller can be used for the first time, its basic settings must be completed or confirmed via the Setup Wizard. This process ensures that ESPEC Web Controller is configured correctly for the intended chamber, which includes the login configuration, chamber interface communication, e-mail alerts, network and administrator's password.

Refer to Section 2.4 for detail on the chamber interface configuration procedure. ESPEC Web Controller will reboot itself to apply the settings.

After ESPEC Web Controller has been (automatically) rebooted, complete the following steps:

  1. Log in as administrator (the default password for the admin account is 'admin'). Refer to Section 1.5.
  2. Click the Setup menu.
  3. Click the Chamber Interface Configuration tab. Confirm that all the settings and parameters (Model, Type, Controller, Options) match those in the following figure:

    Setup page chamber interface configuration

    Refer to Section 10.11 for detail.

  4. Click Apply to apply the settings. The system may go through another reboot to apply all the settings.

17.2 Custom Configuration Files

Both the macro editor file and custom configuration file associated with the dynamic variables for custom Time Signals (Events), Alarms and Warnings need to be uploaded and the translation updated. These two files are:

  1. macro_5.json
  2. Espec_web_config_1.json

These files were included in the software package as part of the shipment of the chamber. The folder name that contains these files is: SOFTWARE-ES.

To upload the above two files, complete the following steps:

  1. Log into ESPEC Web Controller using the Admin account. Refer to Section 1.5 for the default password of the Admin account (if it has not been reset to something else).
  2. Access the Setup menu; click the Macro Editor tab and click Upload (as shown in the following figure)

    macro-editor-002.PNG

  3. Click Browse to locate the macro_5.json file on your local computer, then click Submit.

    macro-editor-003.PNG

  4. Next, click the Chamber Interface Configuration submenu, then click the Upload Configuration button, as shown in the following figure.

    chamber-interface-upload-config-file-001a.PNG

  5. Click the Browse button to locate the Espec_web_config_1.json file on your local computer, then click Submit. An error may occur due to issues resolving the Spanish characters that failed from Unicode conversion. In this case, dynamic variables and their translation must be completed manually.

17.3 Custom Alarms and Communication Configuration via the Admin page

The Admin page is a special page through which many configurations can be done. To finalize the configuration of the Web Controller communication with the TERUMO BCT chamber, the correct quantity of custom alarms and the number of modules to be read from the Watlow F4T are required. At this point, the Web Controller home page may illustrate reading errors from the F4T, as depicted below.

Reading error in status bar

In order to correct this error, the following two parameters must be modified in the Admin page (shown below). Contact our software engineer at ESPEC to assist in accessing this Admin page.

Custom alarm and modules

  1. Edit: Click the pen icon. Scroll down the page to locate the Limits field.
  2. Limits: Remove or delete the Limits field (5) and set it to null (empty).
  3. Alarm Qty: Scroll down further to locate the Alarm Qty field and change the value to 14.
  4. Save Settings: Scroll down to the bottom of the page and click Save.

17.4 Custom Configuration of Events and Alarms Translation via the Admin page

The next custom configuration involves setting the correct entries and translation in Spanish for Loops, Events and Alarms on the Admin page, as shown below. Contact ESPEC software engineer group to assist with this configuration.

Setting loops parameters and translation

Setting events and translation

Setting alarms and translation

Setting alarms and translation

Updated